Skip to content
This repository was archived by the owner on Nov 19, 2024. It is now read-only.

Adjusted Loader widget documentation #5230

Merged
jeff-matthews merged 10 commits into from
Aug 26, 2019
Merged

Adjusted Loader widget documentation #5230

jeff-matthews merged 10 commits into from
Aug 26, 2019

Conversation

@serhiyzhovnir
Copy link
Contributor

@serhiyzhovnir serhiyzhovnir commented Aug 21, 2019 •
edited by jeff-matthews
Loading

Purpose of this pull request

This pull request (PR) improves the documentation about Loader widget.

Improvements:

  • Added examples of the widget initialization
  • Added examples of adding callbacks to processStart and processStop events
  • Added Code Sample and Result sections
  • Also, adjusted the markup

Affected DevDocs pages

Links to Magento source code

whatsnew
Added new code examples to the Loader widget topic.

@devops-devdocs
Copy link
Collaborator

devops-devdocs commented Aug 21, 2019

An admin must run tests on this PR before it can be merged.

@rogyar rogyar self-assigned this Aug 21, 2019
rogyar
rogyar suggested changes Aug 21, 2019
View reviewed changes
@rogyar rogyar added Major Update Significant original updates to existing content 2.2.x 2.3.x Magento 2.3 related changes Technical Updates to the code or processes that alter the technical content of the doc labels Aug 21, 2019
@serhiyzhovnir @rogyar
Adjusted the loader documentation
6ba2dcf 
Co-Authored-By: Yaroslav Rogoza <[email protected]>
@serhiyzhovnir
Copy link
Contributor Author

serhiyzhovnir commented Aug 21, 2019

@rogyar The requested changes were added.
Thank you!

@rogyar
Copy link
Contributor

rogyar commented Aug 22, 2019

Hi @serhiyzhovnir. Please, take a look at the conflicts with the mainline.
Thank you

@serhiyzhovnir
Copy link
Contributor Author

serhiyzhovnir commented Aug 22, 2019

Hi @rogyar
The conflict is resolved.
Thank you!

jeff-matthews
jeff-matthews suggested changes Aug 23, 2019
View reviewed changes
@jeff-matthews jeff-matthews removed the Technical Updates to the code or processes that alter the technical content of the doc label Aug 23, 2019
@serhiyzhovnir
Copy link
Contributor Author

serhiyzhovnir commented Aug 23, 2019

Hi @jeff-matthews
The required changes were added.
Please, check the PR.
Thank you!

jeff-matthews
jeff-matthews approved these changes Aug 23, 2019
View reviewed changes
Copy link
Contributor

@jeff-matthews jeff-matthews left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @serhiyzhovnir!

@jeff-matthews
Copy link
Contributor

jeff-matthews commented Aug 23, 2019

running tests

@jeff-matthews
Copy link
Contributor

jeff-matthews commented Aug 23, 2019

Tests failed due to markdown style rule violations. @serhiyzhovnir, please fix the following issues:

+ rake test:cicd
�[35mTesting Markdown style with mdl ...�[0m
�[31mThe Markdown linter has found 8 issues�[0m
�[33mguides/v2.2/javascript-dev-guide/widgets/widget_loader.md:9: MD009 Trailing spaces
guides/v2.2/javascript-dev-guide/widgets/widget_loader.md:50: MD009 Trailing spaces
guides/v2.2/javascript-dev-guide/widgets/widget_loader.md:58: MD009 Trailing spaces
guides/v2.3/javascript-dev-guide/widgets/widget_loader.md:9: MD009 Trailing spaces
guides/v2.3/javascript-dev-guide/widgets/widget_loader.md:50: MD009 Trailing spaces
guides/v2.3/javascript-dev-guide/widgets/widget_loader.md:58: MD009 Trailing spaces

A detailed description of the rules is available at https://github.com/markdownlint/markdownlint/blob/master/docs/RULES.md

jeff-matthews
jeff-matthews suggested changes Aug 23, 2019
View reviewed changes
Copy link
Contributor

@jeff-matthews jeff-matthews left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Markdown linting failed

@serhiyzhovnir
Copy link
Contributor Author

serhiyzhovnir commented Aug 25, 2019

Hi @jeff-matthews
We have fixed the issue with failed markdown linting.
Please, check it.
Thank you!

@jeff-matthews
Copy link
Contributor

jeff-matthews commented Aug 26, 2019

running tests

@jeff-matthews
Copy link
Contributor

jeff-matthews commented Aug 26, 2019

@serhiyzhovnir, tests failed on image link:

Running ["LinkChecker::DoubleSlashCheck", "HtmlCheck", "ImageCheck", "LinkCheck", "ScriptCheck"] on ["_site"] on *.html... 


Ran on 2803 files!


- internal image /common/images/widget/loader-widget-result.png does not exist
  *  _site/guides/v2.2/javascript-dev-guide/widgets/widget_loader.html (line 424)
  *  _site/guides/v2.3/javascript-dev-guide/widgets/widget_loader.html (line 424)
rake aborted!
HTML-Proofer found 2 failures!```

jeff-matthews
jeff-matthews suggested changes Aug 26, 2019
View reviewed changes
Copy link
Contributor

@jeff-matthews jeff-matthews left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fix broken link to image

@serhiyzhovnir
Copy link
Contributor Author

serhiyzhovnir commented Aug 26, 2019

@jeff-matthews
I've added the missed image.
Thank you!

@jeff-matthews
Copy link
Contributor

jeff-matthews commented Aug 26, 2019

running tests

@jeff-matthews jeff-matthews merged commit 7b89085 into magento:master Aug 26, 2019
@ghost
Copy link

ghost commented Aug 26, 2019

Hi @serhiyzhovnir, thank you for your contribution!
Please, complete Contribution Survey, it will take less than a minute.
Your feedback will help us to improve contribution process.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Reviewers

2 more reviewers

@rogyar rogyar rogyar approved these changes

@jeff-matthews jeff-matthews jeff-matthews approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

@rogyar rogyar

@jeff-matthews jeff-matthews

Labels

2.2.x 2.3.x Magento 2.3 related changes Major Update Significant original updates to existing content Partner: Atwix partners-contribution PR created by Magento partner

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

5 participants

@serhiyzhovnir @devops-devdocs @rogyar @jeff-matthews @magento-engcom-team